/**
 * Copyright (C) 2002-2015   The FreeCol Team
 * <p>
 * This file is part of FreeCol.
 * <p>
 * FreeCol is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 * <p>
 * FreeCol is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with FreeCol.  If not, see <http://www.gnu.org/licenses/>.
 */

package net.sf.freecol.client.gui.action;

import java.awt.event.ActionEvent;

import net.sf.freecol.client.FreeColClient;
import net.sf.freecol.common.model.Tile;
import net.sf.freecol.common.model.TileImprovementType;
import net.sf.freecol.common.model.Unit;


/**
 * An action for using the active unit to add a tile improvement to
 * the unit's tile, possibly changing the tile type in the process. In
 * the original game, artificial tile improvements were clearing,
 * plowing and building a road.
 */
public class ImprovementAction extends UnitAction
{

    private final TileImprovementType improvement;


    /**
     * Creates this action.
     *
     * @param freeColClient The <code>FreeColClient</code> for the game.
     * @param improvement The <code>TileImprovementType</code> to make.
     */
    public ImprovementAction( FreeColClient freeColClient,
                              TileImprovementType improvement )
    {
        super( freeColClient, improvement.getSuffix( ) + "Action" );

        this.improvement = improvement;
        addImageIcons( improvement.getSuffix( ) );
    }


    // Override FreeColAction

    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean shouldBeEnabled( )
    {
        if ( super.shouldBeEnabled( ) )
        {
            Unit selectedUnit = getGUI( ).getActiveUnit( );
            Tile tile = selectedUnit.getTile( );
            return selectedUnit.checkSetState( Unit.UnitState.IMPROVING )
                    && tile != null
                    && tile.isImprovementTypeAllowed( improvement )
                    && improvement.isWorkerAllowed( selectedUnit );
        }
        return false;
    }


    // Interface ActionListener

    /**
     * {@inheritDoc}
     */
    @Override
    public void actionPerformed( ActionEvent ae )
    {
        Unit unit = getGUI( ).getActiveUnit( );
        if ( unit == null ) return;

        igc( ).changeWorkImprovementType( unit, improvement );
    }
}
